Pythonのloggingについて基本的な部分を確認する

Pythonのloggingについてloggerの定義方法の種類や、Formatterの出力できる項目等の基本的な項目について確認してみました。

横山嵩人

2023.12.15

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

DA事業本部の横山です。

今回は。普段から利用しているPythonのloggingについてなんとなくで理解している部分が多かったため、基本的なことから復習したので確認した内容を共有します。

前提条件

本記事で利用しているPythonのバージョンは以下になります。

今回は、以下の項目について公式ドキュメントを中心に確認を行いました。

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

WARNING:root:Watch out!

レベル	いつ使うか
DEBUG	おもに問題を診断するときにのみ関心があるような、詳細な情報。
INFO	想定された通りのことが起こったことの確認。
WARNING	想定外のことが起こった、または問題が近く起こりそうである (例えば、'disk space low') ことの表示。
ERROR	より重大な問題により、ソフトウェアがある機能を実行できないこと。
CRITICAL	プログラム自体が実行を続けられないことを表す、重大なエラー。

普段利用しているログレベルは、DEBUG,INFO,WARNING,ERRORでCRITICALを使うことはほぼない気がします。これはプロジェクト毎のログ設計次第ではありますが、各ログレベルがどういった状況で利用されるのかは意識して使い分ける必要がありますね。

設定用のメソッドを呼び出す。Python コードを明示的に使って、ロガー、ハンドラ、そしてフォーマッタを生成する。
- ハードコードになり柔軟性に書けるため避けたい
ロギング設定ファイルを作り、それを fileConfig() 関数を使って読み込む。
- configparser形式(≒INIファイル)で記述する必要がある
- よく見かけるスタイルではあるが、可読性には欠ける
設定情報の辞書を作り、それを dictConfig() 関数に渡す。
- 設定ファイルに基づく方法の上位版としてPython3.2から提供され、推奨されている模様
- 辞書化さえできれば渡せるので、JSON,YAML,TOML等　設定ファイルの形式は選ばない

以上からdictConfig()用いた実装が推奨されており、設定ファイルを何らかの形で辞書として読み込んでdictConfig()に渡してあげるのがよさそうです。

ここからは、dictConfig()を利用する前提で、その設定辞書を記述する設定ファイルの形式について考えていきます。